vcLayoutSchemaPropertyList

vcLayoutSchemaPropertyList is a layout item and a table-like container for large typed datasets (bool, int, double, vector, matrix, string columns). Records can be visualized in the 3D scene as frames, lines, and labels, with configurable schema indices controlling position, visibility, and color, anchored to a scene node with an optional offset.

See in: Overview

Module: vcCore

Parent: vcLayoutItem

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
DataCount	Integer	R	Gets the number of records in schema.
FrameColorSchemaIndex	Integer	RW	Gets or sets the index of schema property used for coloring frame. The schema property should be a vector data type.
FrameDataSchemaIndex	Integer	RW	Gets or sets the index of schema property used for positional data of record. See more Generally, the schema property is a matrix data type. The positional data is used for visualizing record as a Frame feature in 3D world.
FrameNameColorSchemaIndex	Integer	RW	Gets or sets the index of schema property used for coloring the label of frame. The schema property should be a vector data type.
FrameNameSchemaIndex	Integer	RW	Gets or sets the index of schema property used for labeling the Frame feature of record in 3D world. See more The schema property should be a string data type. The default is -1. This means the Frame feature of record will not be labeled with its custom name rather the number of record in schema.
FrameNameVisibleSchemaIndex	Integer	RW	Gets or sets the index of schema property used for controlling the visibility of label of record in 3D world. See more The schema property should be a Boolean data type. The default is -1. This means labels are visible.
FrameVisibleSchemaIndex	Integer	RW	Gets or sets the index of schema property used for controlling the visibility of Frame feature of record in 3D world. See more The schema property should be a Boolean data type. This also affects the visibility of label of record in 3D world.
LineDisplaySchemaIndex	Integer	RW	Gets or sets the index of schema property used for the position of record in 3D world. This allows you to connect positions with a line generated in 3D world.
Node	vcNode	RW	Gets or sets a node the Frame features of records are attached to in 3D world. See more In some cases, this might be the simulation root node/World node. In other cases, this might be the root node of a workpiece.
PositionMatrix	vcMatrix	RW	Gets or sets an offset for position of record in 3D world. See more The offset is based in coordinate system of Node property. Generally, an offset is applied to compensate for weld torch flares or to adjust position based on Z-axis direction of robot TCP.
SchemaProperties	vcPropertyContainer	R	Gets a list of all schema properties in the layout item. Note: This does not include data values for each record in the schema.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
clearSchema	None	None	Empties the schema, thereby removing all schema properties and setting the data count to zero.
cloneSchemaObject	Boolean	Integer fromDataindex, Integer count, Integer toDataindex	Clones a set of records in a given range. Warning: Currently, you cannot append cloned records to the end of the table. You must insert the copies before an existing record. See more Parameters: fromDataindex (int): defines the first record in range. count (int): defines how many records to clone. toDataindex (int): defines where to insert the copies. Returns: bool: True on success, False otherwise. Exceptions: IndexError: When fromDataindex, count or toDataindex have incorrect values. RuntimeError: When cloning fails for any reason.
deleteSchemaObject	Boolean	Integer fromDataindex, Integer count	Deletes a set of records in a given range. See more Parameters: fromDataindex (int): defines the first record in range. count (int): defines how many records to delete. Returns: bool: True on success, False otherwise. Exceptions: IndexError: When fromDataindex or count have incorrect values. RuntimeError: When delete fails for any reason.
getDataValue	object	Integer dataindex, Integer itemindex	Returns the value of a data field at a given dataIndex and itemIndex. See more Parameters: dataIndex (int): Index of the data entry. itemIndex (int): Index of the schema property. Returns: The value of the schema property of the given data entry. Exceptions: IndexError: When dataIndex or itemIndex are out of range.
getDataValues	tuple	Integer dataIndex	Returns the values of a record at a given dataIndex. See more Parameters: dataIndex (int): Index of the data entry. Returns: tuple: The values of the schema properties at the given data entry. Exceptions: IndexError: When dataIndex is out of range.
setDataValue	Boolean	Integer dataindex, Integer itemindex, object value	Sets the value of a data field at a given dataIndex and itemIndex. The value argument must be a supported data type and match the type of the schema property; otherwise the data field will not reference the new value. See more Note: The value argument can be a vcProperty object, thereby the value of that property is passed to the data field. Parameters: dataIndex (int): Index of the data entry. itemIndex (int): Index of the schema property. value (Any): Value of the data field. Returns: bool: True on success, False otherwise. Exceptions: IndexError: When dataIndex or itemIndex are out of range.
setDataValues	None	Integer dataIndex, Integer itemIndex, tuple values	Sets all values for schema properties of a record at a given dataindex. The values argument must be a tuple with the same amount of elements as there are schema properties. See more Each element's value must be a supported data type and match the type of the corresponding schema property; otherwise the data field will not reference the new value. Note: An element within the tuple provided to the values argument may be a vcProperty object, in which case the corresponding data field receives the property’s value. Parameters: dataIndex (int): Index of the data entry. itemIndex (int): Index of the schema property. values (tuple): Values to be set as a tuple. Returns: bool: True on success, False otherwise. Exceptions: IndexError: When dataIndex or itemIndex are out of range.
updateData	None	Optional Keyword[count = Integer]	Allocates the size of the schema to support a potential amount of elements/entries for schema properties based on the given count. See more Note: The allocation is optional as size is updated automatically based on number of entries. Parameters: Optional: count (int): The size of the schema.